How To

Access the Portal

In order to get access to the eXate portal you will need to sign up for a plan on our developer platform. Once you are set up there you will receive login credentials from a member of the eXate team. With these logins you will be able to access the portal.

Use the following guide to Register on the eXate Developer Portal and configure your Tenancy to access eXate API services.

Register on the eXate Developer Portal

1. Go to the eXate developer portal: https://developer.exate.co/

2. Click the Sign in link at the top right of the page

3. Click the Sign up text to create an account

4. Fill in your details on the Registration Form and click SIGN UP

You will receive an email from developer-support@exate.com. Follow the link in this email to set your password

Connect to a Database

Prerequisites: Please ensure a source connection has already been set up. This will be created in the eXate vault. Only then can you create a connection to a specified database.

1. Navigate to the Datagator menu and select database configuration

2. Click the plus sign to create a new database job definition

3. Select the database type. This could be Sql server, Oracle, Mysql and Snowflake.

4. Select the source connection. As shown, the source connection has already been set up in the eXate Vault.

5. Click connect and the database will appear, allowing you to select the tables you desire.

Create an Application

1. From the Developer Portal, navigate to Applications on the Top Menu Bar.

2. Click the CREATE AN APP button on the top right of the page

3. Fill in the details of your application. Name and Description are mandatory and click NEXT

4. Ignore the optional Type and Client ID fields and click NEXT

5. You need to Subscribe to an eXate source API for your application. Choose APIgator from the search box and eXateTrialAccess (our free API plan) click SUBSCRIBE and NEXT

6. Click the CREATE THE APP button to complete

See the following screenshot for an overview of the sequence to follow to subscribe to an eXate soure API:

If your Application was created successfully you will receive confirmation on the screen and an e-mail.

Procure your API Key

Once you have created your Application, you will need to create an API Key to be able to interact with the eXate API Services.

1. From the Developer Portal, navigate to Applications on the Top Menu Bar.

2. Click on the Application card that you created in the previous step

3. Click on the Subscriptions Menu item in the Sub Menu Tab

4. Click on the Subscription record you created in the previous step for the APIgator service, eXateTrialAccess plan.

5. Clicking on the record will reveal a pop up modal containing your API Key (a GUID). Click on the Copy to Clipboard icon to record your API Key. You will need this key for any HTTP requests to an eXate API endpoint.

See the following screenshot for an overview of the sequence to follow to procure your API Key:

Raise a Technical Support Ticket

There are two ways to create a ticket: through the customer portal or by submitting a ticket via email.

Raise a Ticket Through Customer Portal

1. You must first receive a link from Jira on behalf of eXate to the Customer Support Management Portal.

2. Set up your account, by following the sign-up link.

3. Once the account has been set up, you will be directed to the help centre page. Here you will be able to access release notes, API Access Credentials and raise requests.

4. To raise a request, click on tab "Need to raise a request? Contact us."

5. This will direct you to the Raise a Request categories. Here you can raise a Technical Support request. To raise a Technical Support request, click on the tab “Technical Support”.

6. This will direct you to the Technical Support Request form. Add a summary of the request and details. Add any components or products that the request pertains to. Attach any screen captures, scripts, or other documentation that support the request. Click Send.

7. Once the request has been submitted, you will see a summary of the request.

8. To view requests, you have submitted. Click the “Request Tab”. 8. The Request tab will show you two options:
   

• Created by me: All requests you have submitted.

• All: All requests submitted by you and your organisation.

9. When clicking on either of the options, it will show you all requests you or your organisation have submitted.

10. Jira sends an email message to your address confirming that the request was received.

Raise a Ticket Through Submitting a Ticket via Email

To send a ticket request by email, send email to support@exate.atlassian.net.

1. Open the email program of your choice.

2. In the ‘To’ line, enter the support email address.

3. In the body of your email message, enter as much detail about the product, component, and problem as you have.

4. Click Send. Jira sends an email message to your address confirming that the request was received.